Skip to main content

DescribeMetricMetaList

Description

Query the description of the time series indicator monitoring item that is open to cloud monitoring.

Request Method

POST

Request Path

/apsara/route/cms/DescribeMetricMetaList

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
MetricNameBODYstringNoCPUUtilizationmonitoring indicator name, press equal to match.
PageSizeBODYintegerNo30maximum number per page, default value: 30.
PageNumberBODYintegerNo1paging parameter, default value: 1.
regionIdBODYstringYesNo sample value for this parameter.region id
LabelsBODYstringNo[{"name":"productCategory","value":"kvstore_old"}]filter according to tags, format [{"name":"tag name","value":"tag value"},{"name":"tag name","value":"tag value"}] . The existing tag name is described as follows: MetricCategory: description of monitoring item classification alertEnable: whether an alarm is required alertUnit: Recommended alarm unit unitFactor: unit conversion coefficient minAlertPeriod: minimum alarm period productCategory: product type classification
versionBODYstringNo2016-01-01version of api
NamespaceBODYstringYesacs_kvstoreThe Namespace to which the indicator belongs, used to distinguish each product configuration. You can call the DescribeProjectMeta to view the Namespace value corresponding to each product.

Return data

NameTypeSample valueDescription
DescriptionstringNo sample value for this parameter.monitoring item description.
RequestIdstringNo sample value for this parameter.request ID, used to troubleshoot problems.
MessagestringNo sample value for this parameter.error message.
ResourceNo sample value for this parameter.specific configuration information.
DimensionsstringNo sample value for this parameter.Dimensions of monitoring items. Multiple are separated by half-width commas (,).
LabelsstringNo sample value for this parameter.the tag of the monitoring item, is a JSON String[{"name":"tag name","value":"tag value"}], can be multiple, name can be repeated. Description of existing tag name: metricCategory: Indicator classification alertEnable: whether you can alarm alertUnit: alarm unit unitFactor: unit conversion coefficient minAlertPeriod: minimum alarm period productCategory: product
UnitstringNo sample value for this parameter.the unit of the monitoring item.
CodestringNo sample value for this parameter.status code, 200 indicates success.
StatisticsstringNo sample value for this parameter.Statistical methods, multiple separated by commas (,), for example: Maximum,Minimum,Average.
SuccessbooleanNo sample value for this parameter.whether it succeeded.
NamespacestringNo sample value for this parameter.is used to distinguish product types. the usual naming method is acs_product name.
MetricNamestringNo sample value for this parameter.monitoring item name.
PeriodsstringNo sample value for this parameter.all statistical periods of monitoring items, multiple separated by commas (,): 15,60,900.
TotalCountstringNo sample value for this parameter.total number of records.
ResourcesNo sample value for this parameter.specific configuration information.

Example

Successful Response example

"The successful response sample is not recognizable. Please modify API definition in API gateway before re-create the API document."

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}